<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class openSSO</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class openSSO</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
		<p class="notes">
			Located in <a class="field" href="_open-sso.class.php.html">/open-sso.class.php</a> (line <span class="field">19</span>)
		</p>
		
				
		<pre><a href="../OpenSSO_PHP/openSSO_Abstract.html">openSSO_Abstract</a>
   |
   --openSSO</pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																												
												<div class="method-definition">
											<span class="method-result">(multi)</span>
										<a href="#getSessionData" title="details" class="method-name">getSessionData</a>
											(<span class="var-type">(string)</span>&nbsp;<span class="var-name">$name</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#hookError" title="details" class="method-name">hookError</a>
											(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">(bool)</span>
										<a href="#hookIsError" title="details" class="method-name">hookIsError</a>
											(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#hookLogin" title="details" class="method-name">hookLogin</a>
											(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#hookLogout" title="details" class="method-name">hookLogout</a>
											(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#insertUser" title="details" class="method-name">insertUser</a>
											(<span class="var-type">(array)</span>&nbsp;<span class="var-name">$data</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">(array)</span>
										<a href="#selectUser" title="details" class="method-name">selectUser</a>
											(<span class="var-type">(string)</span>&nbsp;<span class="var-name">$userName</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setSessionData" title="details" class="method-name">setSessionData</a>
											(<span class="var-type">(string)</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">(multi)</span>&nbsp;<span class="var-name">$value</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#updateUser" title="details" class="method-name">updateUser</a>
											(<span class="var-type">(string)</span>&nbsp;<span class="var-name">$userName</span>, <span class="var-type">(array)</span>&nbsp;<span class="var-name">$data</span>)
									</div>
								</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodgetSessionData" id="getSessionData"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getSessionData</span> (line <span class="line-number">28</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get data from the session</p>
<p class="description"><p>Get data from the session</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> Value of the data.</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">(multi)</span>
		<span class="method-name">
			getSessionData
		</span>
					(<span class="var-type">(string)</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">(string)</span>
				<span class="var-name">$name</span><span class="var-description">: Name of the data.</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodgetSessionData">openSSO_Abstract::getSessionData()</a></dt>
						<dd>Get data from the session.</dd>
					</dl>
			
	</div>
<a name="methodhookError" id="hookError"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">hookError</span> (line <span class="line-number">152</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Hook: Error Call this function when the IDP or the SP is down.</p>
<p class="description"><p>Hook: Error Call this function when the IDP or the SP is down.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			hookError
		</span>
					(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">void</span>
				<span class="var-name">0</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodhookError">openSSO_Abstract::hookError()</a></dt>
						<dd>Hook: Error Call this function when the IDP or the SP is down.</dd>
					</dl>
			
	</div>
<a name="methodhookIsError" id="hookIsError"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">hookIsError</span> (line <span class="line-number">139</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Hook: Is Error? Call this function to determine that error is occured or not.</p>
<p class="description"><p>Hook: Is Error? Call this function to determine that error is occured or not.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> 'TRUE' if error is occured and 'FALSE' otherwise.</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">(bool)</span>
		<span class="method-name">
			hookIsError
		</span>
					(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">void</span>
				<span class="var-name">0</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodhookIsError">openSSO_Abstract::hookIsError()</a></dt>
						<dd>Hook: Is Error? Call this function to determine that error is occured or not.</dd>
					</dl>
			
	</div>
<a name="methodhookLogin" id="hookLogin"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">hookLogin</span> (line <span class="line-number">112</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Hook: Login Call this function after the lib checked the required user data, and created the session.</p>
<p class="description"><p>Hook: Login Call this function after the lib checked the required user data, and created the session. (Call this function after the login method.)</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			hookLogin
		</span>
					(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">void</span>
				<span class="var-name">0</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodhookLogin">openSSO_Abstract::hookLogin()</a></dt>
						<dd>Hook: Login Call this function after the lib checked the required user data, and created the session.</dd>
					</dl>
			
	</div>
<a name="methodhookLogout" id="hookLogout"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">hookLogout</span> (line <span class="line-number">126</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Hook: Logout Call this function after the lib &quot;destroy&quot; the session.</p>
<p class="description"><p>Hook: Logout Call this function after the lib &quot;destroy&quot; the session. (Call this function after the logout method.)</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			hookLogout
		</span>
					(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">void</span>
				<span class="var-name">0</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodhookLogout">openSSO_Abstract::hookLogout()</a></dt>
						<dd>Hook: Logout Call this function after the lib &quot;destroy&quot; the session.</dd>
					</dl>
			
	</div>
<a name="methodinsertUser" id="insertUser"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">insertUser</span> (line <span class="line-number">60</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Create user.</p>
<p class="description"><p>Create user. Create user with data from the '$data' param (user's SSO data). Insert to DB or whatever you store the users. Syntax: The data name that you setted in config file ('user' array) with 'sso_' prefix.	        Plus 'user_name', 'user_virid', 'user_groups' variables, and these with 'sso_' prefix.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			insertUser
		</span>
					(<span class="var-type">(array)</span>&nbsp;<span class="var-name">$data</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">(array)</span>
				<span class="var-name">$data</span><span class="var-description">: Single array of the user's SSO data. Keys represents the data name.</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodinsertUser">openSSO_Abstract::insertUser()</a></dt>
						<dd>Create user.</dd>
					</dl>
			
	</div>
<a name="methodselectUser" id="selectUser"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">selectUser</span> (line <span class="line-number">76</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the user's data.</p>
<p class="description"><p>Get the user's data. Select user where the user name is equal with the '$userName' param. Read from DB or whatever you store the users. Return with all of the data that you store to this user (SSO and none SSO data). You must return the data names that the program add when the data stored (insert, update)!</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> Single array of the user's data (SSO and none SSO). Keys represents the data name.</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">(array)</span>
		<span class="method-name">
			selectUser
		</span>
					(<span class="var-type">(string)</span>&nbsp;<span class="var-name">$userName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">(string)</span>
				<span class="var-name">$userName</span><span class="var-description">: The unique user name.</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodselectUser">openSSO_Abstract::selectUser()</a></dt>
						<dd>Get the user's data.</dd>
					</dl>
			
	</div>
<a name="methodsetSessionData" id="setSessionData"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setSessionData</span> (line <span class="line-number">44</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set data to the session.</p>
<p class="description"><p>Set data to the session. Set the '$value' data to the session with '$name' name. If this name exists overwrite it. If this name don't exists create it.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setSessionData
		</span>
					(<span class="var-type">(string)</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">(multi)</span>&nbsp;<span class="var-name">$value</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">(string)</span>
				<span class="var-name">$name</span><span class="var-description">: Name of the data.</span>			</li>
					<li>
				<span class="var-type">(multi)</span>
				<span class="var-name">$value</span><span class="var-description">: Value of the data.</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodsetSessionData">openSSO_Abstract::setSessionData()</a></dt>
						<dd>Set data to the session.</dd>
					</dl>
			
	</div>
<a name="methodupdateUser" id="updateUser"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">updateUser</span> (line <span class="line-number">94</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Update user's data.</p>
<p class="description"><p>Update user's data. Update all (SSO and none SSO) user's data where the user name is equal with the '$userName' param. Update in DB or whatever you store the users. '$data' syntax: The data name that you setted in config file with 'sso_' prefix.                 Plus 'user_name', 'user_virid', 'user_groups' variables, and these with 'sso_' prefix.                 Plus your other data that added with 'setUserData();' function.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			updateUser
		</span>
					(<span class="var-type">(string)</span>&nbsp;<span class="var-name">$userName</span>, <span class="var-type">(array)</span>&nbsp;<span class="var-name">$data</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">(string)</span>
				<span class="var-name">$userName</span><span class="var-description">: The unique user name.</span>			</li>
					<li>
				<span class="var-type">(array)</span>
				<span class="var-name">$data</span><span class="var-description">: Single array of the user's data (SSO and none SSO). Keys represents the data name.</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodupdateUser">openSSO_Abstract::updateUser()</a></dt>
						<dd>Update user's data.</dd>
					</dl>
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../OpenSSO_PHP/openSSO_Abstract.html">openSSO_Abstract</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodopenSSO_Abstract">openSSO_Abstract::openSSO_Abstract()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#method__construct">openSSO_Abstract::__construct()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodgetSessionData">openSSO_Abstract::getSessionData()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodgetUserData">openSSO_Abstract::getUserData()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodhookError">openSSO_Abstract::hookError()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodhookIsError">openSSO_Abstract::hookIsError()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodhookLogin">openSSO_Abstract::hookLogin()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodhookLogout">openSSO_Abstract::hookLogout()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodhttp">openSSO_Abstract::http()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodhttps">openSSO_Abstract::https()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodinsertUser">openSSO_Abstract::insertUser()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodisHttps">openSSO_Abstract::isHttps()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodisLogin">openSSO_Abstract::isLogin()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodlogIn">openSSO_Abstract::logIn()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodlogOut">openSSO_Abstract::logOut()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodselectUser">openSSO_Abstract::selectUser()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodsetSessionData">openSSO_Abstract::setSessionData()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodsetUserData">openSSO_Abstract::setUserData()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodtrigger">openSSO_Abstract::trigger()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#methodupdateUser">openSSO_Abstract::updateUser()</a></span><br>
													<span class="method-name"><a href="../OpenSSO_PHP/openSSO_Abstract.html#method__destruct">openSSO_Abstract::__destruct()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 08 Jan 2010 00:36:02 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>